fix: update how we show pending and scanning status #53112

nkdengineer · 2024-11-26T07:41:43Z

Explanation of Change

Fixed Issues

$ #52921
PROPOSAL: #52921 (comment)

Tests

Create a workspace
Submit an expense with scan receipt
Click on the expense to go to the expense detail
Verify that: 'Scanning...' is displayed
Create an expense with type Card and has pending status
Verify that: 'Card • Pending' is displayed in header text

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-12-02T09:58:43Z

@ntdiary Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

nkdengineer · 2024-12-02T09:59:02Z

I am a little stuck on the Android and iOS Native builds, will add later

ntdiary · 2024-12-03T07:24:16Z

src/components/ReportActionItem/MoneyRequestPreview/MoneyRequestPreviewContent.tsx

@@ -202,6 +202,10 @@ function MoneyRequestPreviewContent({
            message = translate('iou.split');
        }

+        if (TransactionUtils.isPending(transaction)) {


I have a small question: should we use isPending or hasPendingUI here? It depends on whether we want to display the Pending field for the following cases (i.e., isReceiptBeingScanned/isPending/hasPendingRTERViolation):

App/src/libs/TransactionUtils/index.ts

Lines 754 to 759 in 5bb0e9b

/**

* Check if the transaction is pending or has a pending rter violation.

*/

function hasPendingUI(transaction: OnyxEntry<Transaction>, transactionViolations?: TransactionViolations | null): boolean {

return isReceiptBeingScanned(transaction) || isPending(transaction) || (!!transaction && hasPendingRTERViolation(transactionViolations));

}

cc @grgia @shawnborton

BTW, we have removed the Receipt pending match with card transaction message on line 259 in the PR.

Curious what @grgia thinks about that.

Since there is an isScanning that returns early, we no longer need to consider isReceiptBeingScanned.

App/src/components/ReportActionItem/MoneyRequestPreview/MoneyRequestPreviewContent.tsx

Lines 249 to 258 in cefad67

if (isScanning) {

return {shouldShow: true, messageIcon: ReceiptScan, messageDescription: translate('iou.receiptScanInProgress')};

}

if (TransactionUtils.isPending(transaction)) {

return {shouldShow: true, messageIcon: Expensicons.CreditCardHourglass, messageDescription: translate('iou.transactionPending')};

}

if (TransactionUtils.shouldShowBrokenConnectionViolation(transaction?.transactionID ?? '-1', iouReport, policy)) {

return {shouldShow: true, messageIcon: Expensicons.Hourglass, messageDescription: translate('violations.brokenConnection530Error')};

}

if (TransactionUtils.hasPendingUI(transaction, TransactionUtils.getTransactionViolations(transaction?.transactionID ?? '-1', transactionViolations))) {

only need to determine whether both isPending and hasPendingRTERViolation should show "Pending". :)

only need to determine whether both isPending and hasPendingRTERViolation should show "Pending". :)

Hi, @grgia, any thoughts on the comment above? :)

friendly bump @grgia

Hmm if the receipt is just Scanning, it doesn't mean it's pending the same way that a credit card transaction would be pending. So for the scanning case, I don't think we should show that there.

Also, I thought the idea was to also remove the "Receipt scan in progress" small text from the bottom? cc @Expensify/design for a gut check there!

^^ same, I thought so too!

Same here. I thought this is what we were going for:

Then, @nkdengineer, when you have time, can you please update the code according to the above comment?

I'll update soon

shawnborton · 2024-12-17T19:52:25Z

What's the latest on this one? Seems like we hit a slowdown. Let's keep the momentum going so we can get this merged!

grgia

Code LGTM, I like your suggestion to change the name, could you push that? @nkdengineer

nkdengineer · 2024-12-23T09:51:06Z

@ntdiary i fixed lint and updated

ntdiary · 2024-12-23T13:59:08Z

src/components/ReportActionItem/ReportPreview.tsx

@@ -401,7 +401,7 @@ function ReportPreview({
            }
        }
        if (shouldShowScanningSubtitle) {
-            return {shouldShow: true, messageIcon: Expensicons.ReceiptScan, messageDescription: translate('iou.receiptScanInProgress')};
+            return {shouldShow: false, messageIcon: Expensicons.ReceiptScan, messageDescription: translate('iou.receiptScanInProgress')};


@Expensify/design, one more question: we only want to update the expense preview, not the report preview, right? If that's the case, then we don't need to update this ReportPreview file.
But if we also want to update the report preview, this line of code might not be enough, as its display rules are more complex.
Here’s an example of the report preview (mock data):

Hmm interesting, I feel like we should also get rid of the Receipt scan in progress text from the report preview given that you see (1 scanning) in the title above. So yeah, let's update it here too.

Hmm interesting, I feel like we should also get rid of the Receipt scan in progress text from the report preview given that you see (1 scanning) in the title above. So yeah, let's update it here too.

Got it. @nkdengineer, it seems like shouldShowScanningSubtitle is no longer needed? It would be great if you could confirm this again, as the conditions for displayAmount/supportText/PendingMessage are quite complex. 😅

Agree with Shawn. Let's ditch it 🔪

fix: update how we show pending and scanning status

f79edd0

nkdengineer mentioned this pull request Nov 26, 2024

[$250] Update how we show pending and scanning status in the expense preview #52921

Open

nkdengineer added 2 commits December 2, 2024 15:59

Merge branch 'main' into fix/52921

29cffee

fix: style request preview content

1bde136

nkdengineer marked this pull request as ready for review December 2, 2024 09:58

nkdengineer requested a review from a team as a code owner December 2, 2024 09:58

melvin-bot bot requested review from ntdiary and removed request for a team December 2, 2024 09:58

ntdiary reviewed Dec 3, 2024

View reviewed changes

shawnborton requested a review from grgia December 18, 2024 13:30

grgia previously approved these changes Dec 18, 2024

View reviewed changes

nkdengineer added 2 commits December 19, 2024 16:45

Merge branch 'main' into fix/52921

2ca1154

fix logic show pending

37213ad

nkdengineer dismissed grgia’s stale review via 37213ad December 19, 2024 09:47

nkdengineer added 6 commits December 23, 2024 14:55

Merge branch 'main' into fix/52921

f868601

fix lint

9440394

fix lint

980012c

fix lint

f08b0e0

fix lint

f51600b

Not show receipt scan in progress

d9225c8

ntdiary reviewed Dec 23, 2024

View reviewed changes

fix: conflict and update

ab74606

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: update how we show pending and scanning status #53112

fix: update how we show pending and scanning status #53112

nkdengineer commented Nov 26, 2024 •

edited

Loading

melvin-bot bot commented Dec 2, 2024

nkdengineer commented Dec 2, 2024

ntdiary Dec 3, 2024 •

edited

Loading

shawnborton Dec 3, 2024 •

edited

Loading

ntdiary Dec 4, 2024

ntdiary Dec 5, 2024

nkdengineer Dec 10, 2024

shawnborton Dec 19, 2024

trjExpensify Dec 19, 2024

dannymcclain Dec 19, 2024

ntdiary Dec 20, 2024

nkdengineer Dec 23, 2024

shawnborton commented Dec 17, 2024

grgia left a comment

nkdengineer commented Dec 23, 2024

ntdiary Dec 23, 2024 •

edited

Loading

shawnborton Dec 24, 2024

ntdiary Dec 25, 2024

dannymcclain Dec 29, 2024

	/**
	* Check if the transaction is pending or has a pending rter violation.
	*/
	function hasPendingUI(transaction: OnyxEntry<Transaction>, transactionViolations?: TransactionViolations \| null): boolean {
	return isReceiptBeingScanned(transaction) \|\| isPending(transaction) \|\| (!!transaction && hasPendingRTERViolation(transactionViolations));
	}

	if (isScanning) {
	return {shouldShow: true, messageIcon: ReceiptScan, messageDescription: translate('iou.receiptScanInProgress')};
	}
	if (TransactionUtils.isPending(transaction)) {
	return {shouldShow: true, messageIcon: Expensicons.CreditCardHourglass, messageDescription: translate('iou.transactionPending')};
	}
	if (TransactionUtils.shouldShowBrokenConnectionViolation(transaction?.transactionID ?? '-1', iouReport, policy)) {
	return {shouldShow: true, messageIcon: Expensicons.Hourglass, messageDescription: translate('violations.brokenConnection530Error')};
	}
	if (TransactionUtils.hasPendingUI(transaction, TransactionUtils.getTransactionViolations(transaction?.transactionID ?? '-1', transactionViolations))) {

fix: update how we show pending and scanning status #53112

Are you sure you want to change the base?

fix: update how we show pending and scanning status #53112

Conversation

nkdengineer commented Nov 26, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 2, 2024

nkdengineer commented Dec 2, 2024

ntdiary Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

shawnborton Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shawnborton commented Dec 17, 2024

grgia left a comment

Choose a reason for hiding this comment

nkdengineer commented Dec 23, 2024

ntdiary Dec 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkdengineer commented Nov 26, 2024 •

edited

Loading

ntdiary Dec 3, 2024 •

edited

Loading

shawnborton Dec 3, 2024 •

edited

Loading

ntdiary Dec 23, 2024 •

edited

Loading